Skip to content

docs: add troubleshooting section for documentation #4070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 3, 2021
Merged

docs: add troubleshooting section for documentation #4070

merged 1 commit into from
Sep 3, 2021

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Aug 30, 2021 •
edited
Loading

This PR adds a section called Documentation and Troubleshooting to explain how to troubleshoot doc issues in code-server. Inspired by #4060

Fixes N/A

Docs load up just fine in the preview

image

@jsjoeio jsjoeio requested a review from a team as a code owner August 30, 2021 17:33
@jsjoeio jsjoeio self-assigned this Aug 30, 2021
@jsjoeio jsjoeio added the docs Documentation related label Aug 30, 2021
@jsjoeio jsjoeio added this to the 3.12.0 milestone Aug 30, 2021
@codecov
Copy link

codecov bot commented Aug 30, 2021

Codecov Report

Merging #4070 (2dd85fb) into main (c0d62da) will not change coverage.
The diff coverage is n/a.

❗ Current head 2dd85fb differs from pull request most recent head bd1e9b3. Consider uploading reports for the commit bd1e9b3 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4070   +/-   ##
=======================================
  Coverage   63.51%   63.51%           
=======================================
  Files          36       36           
  Lines        1872     1872           
  Branches      379      379           
=======================================
  Hits         1189     1189           
  Misses        580      580           
  Partials      103      103

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c0d62da...bd1e9b3. Read the comment docs.

@github-actions
Copy link

✨ Coder.com for PR #4070 deployed! It will be updated on every commit.

jawnsy
jawnsy approved these changes Sep 3, 2021
View reviewed changes
Copy link
Contributor

@jawnsy jawnsy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kind of an unfortunate debugging process, though I don't have any better ideas, I'm afraid

@jsjoeio jsjoeio merged commit 67b23aa into main Sep 3, 2021
@jsjoeio jsjoeio deleted the jsjoeio-troubleshoot-docs branch September 3, 2021 21:10
@jsjoeio
Copy link
Contributor Author

jsjoeio commented Sep 3, 2021

Kind of an unfortunate debugging process, though I don't have any better ideas, I'm afraid

Me neither 😢 maybe one day it will be better

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jawnsy jawnsy jawnsy approved these changes

Assignees

@jsjoeio jsjoeio

Labels
docs Documentation related
Projects
None yet
Milestone
3.12.0
Development

Successfully merging this pull request may close these issues.
2 participants
@jsjoeio @jawnsy